home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #2 / Monster Media No. 2 (Monster Media)(1994).ISO / renegade / xcbv30.zip / XCBV.DOC < prev    next >
Text File  |  1994-06-22  |  25KB  |  531 lines

  1.  
  2.                        ╔════════════════════════════════╗
  3.                        ║   Express Call-Back Verifier   ║
  4.                        ║          Version 3.0           ║
  5.                        ║  For Renegade Bulletin Boards  ║
  6.                        ║  Copyright 1994 Phil Baggett   ║
  7.                        ║      All Rights Reserved       ║
  8.                        ╚════════════════════════════════╝
  9.  
  10.  
  11.     FILE LIST
  12.     ---------
  13.  
  14.     The Express Call-Back Verifier (XCBV) package consists of the following
  15.     files:
  16.  
  17.         XCBV.DOC     - Main documentation
  18.         HISTORY.DOC  - Program revision history
  19.         INSTALL.BAT  - Installation utility
  20.         UPGRADE.BAT  - Upgrade utility
  21.         REGISTER.FRM - Registration form
  22.         XCBVPACK.FLS - Packed program files
  23.         HELPME.BAT   - Brief installation/upgrade instructions
  24.  
  25.  
  26.     LICENSE
  27.     -------
  28.  
  29.     XCBV is distributed as shareware. You may use this program for a trial
  30.     period of 14 days; thereafter you must register with the author or
  31.     discontinue use. See "REGISTRATION" near the end of this file.
  32.  
  33.     You may freely distribute this evaluation package so long as all files
  34.     are unmodified and are included in each transfer. You may NOT
  35.     distribute, by any means whatsoever, the "key" file you receive when you
  36.     register (which is not part of this evaluation package).
  37.  
  38.  
  39.     REQUIREMENTS
  40.     ------------
  41.  
  42.     The DOS SHARE.EXE program must be in memory for this program to function
  43.     properly under a multinode environment.
  44.  
  45.     This version of XCBV was developed for Renegade release 05-31-94.
  46.     Compatibility with later versions is likely but not guaranteed, since
  47.     Renegade's file structures may change. Before trying it, back up your
  48.     user file, USERS.DAT, located in the DATA directory.
  49.  
  50.     I plan to continue to modify this program as needed to be compatible
  51.     with future versions of Renegade if there's enough demand for it
  52.     (registrations).
  53.  
  54.  
  55.     INTRODUCTION
  56.     ------------
  57.  
  58.     The Express Call-Back Verifier serves these main purposes:
  59.  
  60.         (1) Automatically upgrades users' access levels to predetermined
  61.             values after successful verification.
  62.  
  63.         (2) Keeps a record of users' tested-and-verified phone numbers.
  64.  
  65.         (3) Allows SysOps to prevent users from calling under multiple user
  66.             accounts.
  67.  
  68.     This CBV is quite different from others you may have used. Foremost is
  69.     the simplicity involved in set-up and maintenance. You don't have to
  70.     list all your local phone number prefixes. Neither do you have to rely
  71.     on other add-on utilities to keep your call-back records up to date.
  72.  
  73.         ■  SysOps and Co-SysOps, whether running the door locally or from a
  74.            remote location, can search through and edit the call-back
  75.            database, which will contain each verified user's name, real
  76.            name, phone number, and date of verification.
  77.  
  78.         ■  A special option is included for globally scanning and updating
  79.            the call-back database, so SysOps can plug some or all users'
  80.            current phone numbers into the database.
  81.  
  82.         ■  Customized text or ANSI files will be displayed at appropriate
  83.            times when the door is being run, so you can give the program a
  84.            personal touch.
  85.  
  86.         ■  Keeps a detailed log of all errors, call-back failures, and other
  87.            noteworthy events (unless error logging is turned off).
  88.  
  89.  
  90.     INSTALLATION
  91.     ------------
  92.  
  93.     To install the program for the first time, run the INSTALL program and
  94.     carefully follow the instructions. If you're upgrading from a previous
  95.     version, run UPGRADE instead.
  96.  
  97.     -- Configuration --
  98.  
  99.     Run CONFIG.EXE to set up XCBV, and any time you need to make a change to
  100.     any of the set-up options. (You must be in the directory where XCBV is
  101.     installed.)  This configuration includes options that tell the program
  102.     where your BBS files are, how to use your modem, and how you want to
  103.     upgrade users.
  104.  
  105.     Next, use a text editor to modify the SPECIAL.TXT file. There are two
  106.     sections in this file. First is the "Special Area Codes" section, where
  107.     you need to list your local area code, as well as any other area codes
  108.     that need to be specially handled. Beside each code, separated by a
  109.     space, you can specify exactly what to dial before the phone number when
  110.     calling users within that area. If you don't give a prefix, then only
  111.     the user's actual number is dialed (###-####). Examples:
  112.  
  113.         404        <- For area code 404, just dial "###-####" (no prefix)
  114.         234 8-     <- For 234, dial "8-###-####"
  115.         567 9,567  <- For 567, dial "9,567###-####"
  116.  
  117.     Of course, for long-distance calls (if allowed), these numbers would be
  118.     preceded by the long-distance prefix you established with CONFIG.EXE
  119.     (usually "1-").
  120.  
  121.     Next is the "Illegal Dialing Sequences" section. Here you can list any
  122.     sequences of digits that the program should not be allowed to dial as
  123.     the first part of a number. Each line may contain a number sequence up
  124.     to 14 digits. This feature provides a safeguard against users trying to
  125.     cause the SysOp grief by making the verifier call the 911 emergency
  126.     service, 976 or 1-900 toll numbers, etc.
  127.  
  128.     NOTE:  This feature was not intended to be used to "lock out" problem
  129.            users. The easiest way to do that is explained later under "EDIT
  130.            MODE".
  131.  
  132.     -- Display Files --
  133.  
  134.     Edit the special display files as desired (or create your own) to
  135.     conform to your set-up. (You will need an ANSI editor, such as TheDraw,
  136.     to change the ANSI screens.)  When the program needs to display one of
  137.     these, it first looks for the filename with the .ANS extension, and if
  138.     found, shows it as an ANSI display (if the user has ANSI). Otherwise, it
  139.     looks for the .ASC extension and shows it. (This method is similar to
  140.     how Renegade itself works.)  Note that Renegade color codes, as well as
  141.     MCI codes, are NOT supported; use .ANS files if you want color.
  142.  
  143.     The display files (not including extensions) are:
  144.  
  145.         INTRO    - Displayed first, just after the program title and
  146.                    copyright information.
  147.         INUSE    - Displayed if someone's using the program on another node.
  148.         NOTIME   - Displayed when user has less than the configured minimum
  149.                    time remaining.
  150.         NOLONGD  - Displayed to long-distance callers if long-distance
  151.                    call-backs are not allowed, AND "auto-upgrade LD callers"
  152.                    is disabled.
  153.         AUTOUPLD - Displayed to long-distance callers if "auto-upgrade LD
  154.                    callers" enabled, just before returning to BBS.
  155.         BADNUM   - Displayed when user supplies a number that would cause an
  156.                    illegal dialing sequence (described above), just before
  157.                    giving him another try.
  158.         PHONEDUP - Displayed when user's phone number is already recorded in
  159.                    the call-back database under someone else's name.
  160.         INSTRUCT - Displayed just before asking the user if he's ready to
  161.                    disconnect for call-back.
  162.         SUCCESS  - Displayed after successful verification.
  163.  
  164.     -- Renegade Set-Up --
  165.  
  166.     Inside Renegade, add a menu command that generates the appropriate
  167.     dropfile type and runs the XCBV.BAT batch file with the %N (node number)
  168.     and %# (user number) parameters. For example:
  169.  
  170.         Menu filename: MAIN
  171.         Command #1 of 26
  172.  
  173.         1. Long descript :(=)Call-Back Verifier - For new users
  174.         2. Short descript:(=)Call-Back Ver.
  175.         3. Menu keys     :=
  176.         4. ACS required  :"s255|(s30!s31)"
  177.         5. Cmdkeys       :DW
  178.         6. Options       :C:\BBS\DOORS\XCBV\XCBV.BAT %N %#
  179.            Flags         :None
  180.         Q. Quit
  181.  
  182.     NOTE:  Renegade must run the BATCH file, not XCBV.EXE directly.
  183.  
  184.     The above menu command would run the verifier when the user pressed the
  185.     equals sign (=). Only users with a SL of either 255 (the SysOp) or 30
  186.     (new user perhaps) could access the command. This example would create
  187.     a CALLINFO.BBS dropfile and run XCBV.BAT, which is located in the XCBV
  188.     program's main directory, C:\BBS\DOORS\XCBV.
  189.  
  190.     Instead of having the option on a displayed menu, as would be the case
  191.     above, you might want to have Renegade automatically run the verifier if
  192.     the user has a certain "new user" SL. Refer elsewhere for more
  193.     information about Renegade's menu commands.
  194.  
  195.     Now, modify the included batch file, XCBV.BAT, as necessary, so that it
  196.     changes to the program directory and executes the call-back program,
  197.     passing the %1 and %2 parameters. For example:
  198.  
  199.         C:
  200.         CD \BBS\DOORS\XCBV
  201.         XCBV.EXE %1 %2
  202.  
  203.  
  204.     PRELIMINARY NOTES
  205.     -----------------
  206.  
  207.     Before you use this program, BACKUP YOUR USER FILE (USERS.DAT)!  This
  208.     file should be located in your DATA directory. Although the program's
  209.     been tested extensively, there are no guarantees. Be warned.
  210.  
  211.     The program will function locally (without a real carrier), but it still
  212.     reads the BBS dropfile (see "INSTALLATION", "Renegade Set-Up"), and it
  213.     still needs the BBS node number and user number parameters passed. For
  214.     these reasons, testing is most easily accomplished by logging onto your
  215.     BBS locally and running the verifier as a user would.
  216.  
  217.     When run in local mode, it will not attempt the actual call-back
  218.     process. It runs through a simulated call-back, to allow you to see what
  219.     users will see. Remote users with High Security Access can also do this.
  220.     In a simulated call-back, nothing except program errors is written to
  221.     the log file, and the phone number is never added to the database;
  222.     however, the user's access is still "upgraded" as specified in your
  223.     configuration.
  224.  
  225.     Disabling error logging is not recommend, at least until you have the
  226.     program running smoothly. If a user reports that he received a "Fatal
  227.     Error" message, and you weren't there to watch the error message, you'll
  228.     need to check the log file. You'll also need to periodically check the
  229.     log to make sure folks are not having problems getting verified. The
  230.     most recent messages are listed at the bottom of the file. You can edit
  231.     or delete the log file at any time if desired.
  232.  
  233.     As with all your important BBS files, you should backup the call-back
  234.     database file (XCBV.DAT) regularly in case it somehow gets corrupted.
  235.  
  236.     If you have any problems getting the program to work properly, see
  237.     "TROUBLESHOOTING" later in this document.
  238.  
  239.  
  240.     USING THE PROGRAM
  241.     -----------------
  242.  
  243.     Use of the program is fairly straightforward. When a user runs the
  244.     program, it asks him whether he is long-distance. If he says yes, and
  245.     the SysOp allows LD call-backs, the LD prefix is dialed before the
  246.     number; if he says no and he's lying, the call shouldn't go through
  247.     since the LD prefix is not used. If he says he's LD and LD call-backs
  248.     are not allowed, a special file is displayed and the program exits back
  249.     to the BBS.
  250.  
  251.     The program allows the user to correct his phone number (obtained from
  252.     his BBS record) if necessary. If the user tries to make the verifier
  253.     dial an illegal sequence (explained earlier), the attempt is recorded in
  254.     the log file (if used), and the number is refused.
  255.  
  256.     If the program finds an existing call-back record for the user (same
  257.     real name and phone number), the program assumes the user's BBS account
  258.     was deleted, perhaps due to lack of activity, so it immediately upgrades
  259.     the user and exits. For this reason, you should not allow users whom you
  260.     purposely downgraded to run the verifier.
  261.  
  262.     After calling the user back, the program asks for the user's BBS
  263.     password. If incorrect after 3 tries, the user is disconnected; if
  264.     correct, the user's name, real name, and phone number are stored in the
  265.     database, and the user is upgraded as specified in your configuration.
  266.     After call-back, local callers are normally returned to the BBS and
  267.     long-distance callers are disconnected to save on your phone bill.
  268.  
  269.     If verification fails, either because the program can't reconnect or the
  270.     user failed the password check, the user's access is unchanged, and the
  271.     reason for failure is written to the log file (if used).
  272.  
  273.     In cases where the program disconnects the user, upon returning to the
  274.     board Renegade will detect a lost carrier, so there will be a "Hung up"
  275.     entry in Renegade's SysOp log, which is normal.
  276.  
  277.     When a user can't complete call-back verification (because there's a
  278.     duplicate phone number on record, he's calling LD and LD call-backs
  279.     aren't allowed, etc.), you'll need to manually upgrade the user if you
  280.     want to give him access.
  281.  
  282.     -- Upgrading Users --
  283.  
  284.     XCBV upgrades the user just as if you went to the user's account inside
  285.     Renegade and validated him that way. Therefore, you'll probably want to
  286.     set up a validation level (A-Z) in Renegade for users who complete
  287.     call-back verification.
  288.  
  289.     Verified users are upgraded to the validation level you specified when
  290.     you configured the program. Access settings such as Security Level (SL)
  291.     and expiration date are set accordingly. When setting the user's AC and
  292.     AR flags, these are adjusted according to whether your chosen
  293.     verification level is specified as Hard or Soft.
  294.  
  295.     As with manual validation in Renegade's user editor, the number of
  296.     credits the user has is increased by the number established for your
  297.     verification level. For this reason, you normally should not allow a
  298.     user to access the verifier more than once, since he could accumulate
  299.     undeserved credits by running the program over and over, and each time
  300.     XCBV would find his record, go ahead and upgrade him, and dump him back
  301.     to the BBS.
  302.  
  303.  
  304.     THE EDITOR
  305.     ----------
  306.  
  307.     The Editor, EDIT.EXE, allows viewing/editing of the call-back database.
  308.     As with XCBV.EXE, you must be in the main program directory before
  309.     running the Editor. However, it can be run either at the DOS prompt or
  310.     from your BBS, either from a local or remote logon. This allows you or
  311.     any Co-SysOps to periodically check and maintain the database if
  312.     desired.
  313.  
  314.     To start the Editor from the DOS prompt, simply go to the main program
  315.     directory and run EDIT.EXE. Unless the node number is passed to the
  316.     Editor program (i.e. "EDIT 1"), it runs in local mode. Running the
  317.     Editor while inside your BBS requires a little preparation.
  318.  
  319.     -- Running the Editor from Your BBS --
  320.  
  321.     This section explains how to set up the Editor to be run from inside
  322.     your BBS via a menu command. Although optional, this is handy if you
  323.     frequently call your own board or have a Co-SysOp who is in charge of
  324.     new user verification. If you intend to only run the Editor from the DOS
  325.     prompt, feel free to skip this section.
  326.  
  327.     As with the XCBV.EXE program, the Editor should be run from a batch file
  328.     if it is to be accessed while logged onto your BBS. Create a Renegade
  329.     menu command similar to the one that runs XCBV.BAT. Here's an example:
  330.  
  331.         Menu filename: MAIN
  332.         Command #1 of 26
  333.  
  334.         1. Long descript :(/E) CBV Editor - View/edit CBV database
  335.         2. Short descript:(/E) CBV Editor
  336.         3. Menu keys     :/E
  337.         4. ACS required  :"s255"
  338.         5. Cmdkeys       :DW
  339.         6. Options       :C:\BBS\DOORS\XCBV\EDIT.BAT %N
  340.            Flags         :None
  341.         Q. Quit
  342.  
  343.     NOTE:  Renegade must run the BATCH file, not EDIT.EXE directly, and must
  344.            pass the %N (node number) parameter. 
  345.  
  346.     Now modify the included batch file, EDIT.BAT, as necessary, so that it
  347.     changes to the program directory and executes the Editor, passing the %1
  348.     parameter. For example:
  349.  
  350.         C:
  351.         CD \BBS\DOORS\XCBV
  352.         EDIT.EXE %1
  353.  
  354.  
  355.     USING THE EDITOR
  356.     ----------------
  357.  
  358.     Inside the Editor, you can go to a specific record number, search for a
  359.     certain record by partial user name, real name, or phone number, and
  360.     make any desired changes. Most commands on the menus are
  361.     self-explanatory. Note that you can usually abort an operation by just
  362.     hitting ENTER at the prompt.
  363.  
  364.     When running searches on the database, the Editor will find records that
  365.     contain the given string of characters. For example, if you're looking
  366.     for Samantha Golden's record, you could search for "Sam" or "Gold" in
  367.     the Real Name field.
  368.  
  369.     If you want to "lock out" a certain phone number, simply add a call-back
  370.     record to the database. For the user name, you might want to enter
  371.     something like "LOCKED"; for the phone number, enter the number you
  372.     want "locked out". (This method allows you to search for "LOCKED" in the
  373.     user name field to view/edit all your lock-outs.)
  374.  
  375.  
  376.     ADDING NUMBERS FROM YOUR BBS USER FILE
  377.     --------------------------------------
  378.  
  379.     One option that deserves further explanation, the "Scan & update
  380.     records" option, was included so that you could have a fairly accurate
  381.     and complete record of all your current users' phone numbers when you
  382.     first install the verifier, without forcing all current users to run it.
  383.     USE THIS WITH CAUTION, because indiscriminate use will cause undesired
  384.     additions to the database. If the verifier has already upgraded a
  385.     substantial number of people, you might want to backup the database just
  386.     before using this option.
  387.  
  388.     With this option, you can scan for certain user names, certain security
  389.     levels, or all users. It searches through your BBS user file and adds
  390.     them (you can confirm each addition if desired). Keep in mind that the
  391.     numbers in Renegade's user file are users' voice numbers, so in some
  392.     cases the number added to the call-back database may not be the user's
  393.     data line.
  394.  
  395.     You're also given the option of checking for duplicate accounts while
  396.     scanning. If you choose to do so, then as each user's account is
  397.     scanned, the Editor makes sure there are no other records with the same
  398.     phone number already in the call-back database. Although this option
  399.     takes longer, it helps you track down false user accounts.
  400.  
  401.     The Editor reports (on screen and to the log file, if used) any
  402.     duplicate phone numbers it finds (when the users' real names don't
  403.     match). Remember that these may in fact be separate individuals who
  404.     reside in the same household, so you'll have to decide what to do about
  405.     their access (voice verification perhaps). In the case of duplicates,
  406.     the one already in the call-back database will remain there, and the
  407.     duplicate in the user file is not added.
  408.  
  409.     Remember, the "Scan & update records" option should normally only be
  410.     needed once -- when you first install the verifier -- if you use it at
  411.     all. After that, the verifier will keep a lookout for duplicate numbers
  412.     as each user tries to get verified.
  413.  
  414.  
  415.     TROUBLESHOOTING
  416.     ---------------
  417.  
  418.     This section was included to help solve common problems that occur while
  419.     using (or trying to use) this program. If you're still having problems
  420.     after looking over this section, please don't hesitate to contact the
  421.     author or another SysOp that uses this program.
  422.  
  423.     First of all, an improper configuration can be the cause of many errors,
  424.     so run CONFIG and check EVERY set-up option first. Also check the
  425.     SPECIAL.TXT file for errors in syntax or format. Another general
  426.     suggestion is to make sure you followed all installation instructions to
  427.     the letter. Here are some common problems and their causes:
  428.  
  429.     ■■■  Program reports "Error opening BBS user/system file(s)"
  430.  
  431.       The only known cause for this error is an incorrect setting for your
  432.       "BBS Main Directory". Run CONFIG and make sure this is set to the
  433.       directory where RENEGADE.DAT is located.
  434.  
  435.     ■■■  Reports "Error accessing BBS dropfile..."
  436.  
  437.       The program can't find the dropfile. This error has several causes:
  438.  
  439.       1. You're running the program from outside Renegade (the DOS command
  440.          line), and a dropfile doesn't exist in the proper place. Try
  441.          running it from a menu while logged onto your board.
  442.  
  443.       2. The dropfile type you specified in the configuration is not the
  444.          same as the one Renegade created. If you use CALLINFO.BBS, then
  445.          your Cmdkeys field in your menu command should be DW.
  446.  
  447.       3. Your "System Configuration" -> "Modem/Node Configuration" -> "Path
  448.          for door files" setting is blank or otherwise incorrect. Make sure
  449.          this is set to the path where you want dropfiles (such as
  450.          CALLINFO.BBS) created when your doors are run. Do this for EACH
  451.          NODE if you're running a multi-node system.
  452.  
  453.     ■■■  Reports "Error opening NODEx.DAT"
  454.  
  455.       The program doesn't find the indicated file where expected. Under
  456.       "System Config" -> "Main BBS Configuration", make sure the "RAM
  457.       drive/multinode path" points to the location of your NODE*.DAT files.
  458.  
  459.     ■■■  Reports "Change to the directory where XCBV is installed..."
  460.  
  461.       The main program, XCBV.EXE, was not run from your XCBV directory.
  462.       Make sure the Options field of your Renegade menu command specifies
  463.       the full path to your batch file, and that your batch file changes to
  464.       your XCBV directory FIRST, and then runs XCBV.EXE. Renegade should
  465.       NOT run the .EXE directly, but rather the BATCH file.
  466.  
  467.     ■■■  Program doesn't correctly upgrade a user
  468.  
  469.       One known cause of this problem is a corrupted USERS.DAT. Generally
  470.       speaking, if XCBV can ever upgrade ANY user, it is functioning
  471.       properly with your version of Renegade.
  472.  
  473.       First try deleting USERS.IDX so that Renegade will recreate a fresh
  474.       index file, and then restart your BBS and run the verifier. If the
  475.       problem persists, a possible solution is to retrieve USERS.DAT from
  476.       your most recent backup, delete the .IDX file again, and give it a
  477.       try. It's recommended that you first rename your current USERS.DAT in
  478.       case this suggestion doesn't help.
  479.  
  480.  
  481.     CONTACTING THE AUTHOR
  482.     ---------------------
  483.  
  484.     Thanks for trying this program, and if you have any comments, questions,
  485.     or problems, please let me know. The quickest way to reach me is to
  486.     call my BBS:
  487.  
  488.                                     BETATRON
  489.                                  (404) 321-0393
  490.                            Located in Atlanta, Georgia
  491.  
  492.     If you prefer or can't seem to access my BBS, please write to this
  493.     address:
  494.  
  495.         Phil Baggett
  496.         2775 NE Expressway, #3-1
  497.         Atlanta, GA  30345
  498.  
  499.  
  500.     REGISTRATION
  501.     ------------
  502.  
  503.     XCBV is the result of many hours of hard work, and your support is
  504.     necessary to ensure the future of the program. When you register,
  505.     you'll receive a "key" file that you copy to your XCBV directory to
  506.     remove the sign-off shareware notice from the program. This "key" will
  507.     register future versions as well, unless I change the registration
  508.     requirements. The registration cost is $20.
  509.  
  510.     -- How to Register --
  511.  
  512.     Use the included REGISTER.FRM file and follow the directions therein.
  513.     In addition to the key file, the disk you receive will include the
  514.     latest version of the program. Remember, you may NOT distribute the key
  515.     file you receive in any manner whatsoever.
  516.  
  517.  
  518.     DISCLAIMER
  519.     ----------
  520.  
  521.     The Author, Phil Baggett, hereby disclaims all warranties, express or
  522.     implied, concerning this software. The Author shall not be liable for
  523.     any damage caused by this software (whether or not he is aware that such
  524.     damage may occur) and shall not be liable for errors in any part of the
  525.     software documentation. Furthermore, the Author is not obligated to
  526.     continue to update or otherwise modify the program in any way.
  527.  
  528.     By using this software, the user agrees to the above terms.
  529.  
  530.                                     <<END>>
  531.